Class EnvironmentImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.EnvironmentImpl
All Implemented Interfaces:
IPCObject, Environment

public class EnvironmentImpl extends IPCObjectImpl implements Environment
Information provided by the PKI file:

    \class Environment
    
    \brief An object in the Physical Workspace.
    
    \example appWindow().getActiveWorkspace().getRootPhysicalObject().getEnvironment()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • pauseTime

      public void pauseTime()
      Information provided by the PKI file:
      
          \brief Pauses the environment time.
          
              
      Specified by:
      pauseTime in interface Environment
    • resumeTime

      public void resumeTime()
      Information provided by the PKI file:
      
          \brief Resumes the environment time.
          
              
      Specified by:
      resumeTime in interface Environment
    • isTimeRunning

      public boolean isTimeRunning()
      Information provided by the PKI file:
      
          \brief Returns true if the environment time is running, false if paused.
          
          \return bool, true if the environment time is running, false if paused.
          
              
      Specified by:
      isTimeRunning in interface Environment
      Returns:
      boolean Returns a boolean
    • getTimeInSeconds

      public int getTimeInSeconds()
      Information provided by the PKI file:
      
          \brief Returns the current environment runtime, in seconds.  The value loops, so after 24 hours it resets to 0.
          
          \return int, the current environment runtime, in seconds.
          
              
      Specified by:
      getTimeInSeconds in interface Environment
      Returns:
      int Returns a int
    • setTimeInSeconds

      public void setTimeInSeconds(int seconds)
      Information provided by the PKI file:
      
          \brief Sets the current environment time to the given time, in seconds.  Time loops every 24 hours.
          
          \param seconds, the number of seconds to set the current environment time to.  Time loops every 24 hours so the valid range is [0, 86400).
          
              
      Specified by:
      setTimeInSeconds in interface Environment
      Parameters:
      seconds - Takes in a parameter of seconds
    • getTimeMultiplier

      public float getTimeMultiplier()
      Information provided by the PKI file:
      
          \brief Multiplier used when calculating how much environment time passes each step, in seconds.
          
          \return float, the current environment runtime, in seconds.
          
              
      Specified by:
      getTimeMultiplier in interface Environment
      Returns:
      float Returns a float
    • setTimeMultiplier

      public void setTimeMultiplier(float x)
      Information provided by the PKI file:
      
          \brief Sets the multiplier used when calculating how much environment time passes each step, in seconds.
          
          \param x, the number of seconds to set the step multipler as.
          
              
      Specified by:
      setTimeMultiplier in interface Environment
      Parameters:
      x - Takes in a parameter of x
    • getKeyframeCount

      public int getKeyframeCount()
      Information provided by the PKI file:
      
          \brief How many key frames are in the environment.
          
          \return int, the number of key frames in the environment.
          
              
      Specified by:
      getKeyframeCount in interface Environment
      Returns:
      int Returns a int
    • getKeyframeAt

      public EnvironmentKeyframe getKeyframeAt(int index)
      Information provided by the PKI file:
      
          \brief How Returns a keyframe at a specified index.
          
          \param index, the keyframe to retrive.  Range of [0, getKeyframeCount()).
          
          \return EnvironmentKeyframe, the keyframe at the given index.
          
              
      Specified by:
      getKeyframeAt in interface Environment
      Parameters:
      index - Takes in a parameter of index
      Returns:
      EnvironmentKeyframe Returns a EnvironmentKeyframe
    • addKeyframe

      public EnvironmentKeyframe addKeyframe(int timeInSeconds)
      Information provided by the PKI file:
      
          \brief Adds a keyframe at the specified time and returns the new keyframe.
          
          \param time, the time to add the keyframe at, in seconds.  Time loops every 24 hours so the valid range is [0, 86400).
          
          \return EnvironmentKeyframe, the keyframe added.
          
              
      Specified by:
      addKeyframe in interface Environment
      Parameters:
      timeInSeconds - Takes in a parameter of timeInSeconds
      Returns:
      EnvironmentKeyframe Returns a EnvironmentKeyframe
    • hasKeyframeAtTime

      public boolean hasKeyframeAtTime(int time)
      Information provided by the PKI file:
      
          \brief Returns if there is a keyframe at the given time.
          
          \param time, time in seconds to retrive the keyframe for.  Time loops every 24 hours so the valid range is [0, 86400).
          
          \return bool, true if there was a keyframe, false if not.
          
              
      Specified by:
      hasKeyframeAtTime in interface Environment
      Parameters:
      time - Takes in a parameter of time
      Returns:
      boolean Returns a boolean
    • getKeyframeIndexAtTime

      public int getKeyframeIndexAtTime(int time)
      Information provided by the PKI file:
      
          \brief Returns the index of a keyframe at the given time if one exists.
          
          \param time, time in seconds to retrive the keyframe index for.  Time loops every 24 hours so the valid range is [0, 86400).
          
          \return int, value is the index if a match was found, -1 if not.
          
              
      Specified by:
      getKeyframeIndexAtTime in interface Environment
      Parameters:
      time - Takes in a parameter of time
      Returns:
      int Returns a int
    • getStagingKeyframe

      public EnvironmentKeyframe getStagingKeyframe()
      Information provided by the PKI file:
      
          \brief Returns the staging keyframe.
          
          \return EnvironmentKeyframe, value is the staging keyframe.
          
              
      Specified by:
      getStagingKeyframe in interface Environment
      Returns:
      EnvironmentKeyframe Returns a EnvironmentKeyframe
    • addKeyframeFromStaging

      public int addKeyframeFromStaging()
      Information provided by the PKI file:
      
          \brief Adds a keyframe from staging.
          
          \return int, value is index of the keyframe after it gets added from staging.
          
              
      Specified by:
      addKeyframeFromStaging in interface Environment
      Returns:
      int Returns a int
    • removeKeyframe

      public void removeKeyframe(int index)
      Information provided by the PKI file:
      
          \brief Removes the keyframe at the given index if the keyframe exists and isn't the start or end.
          
          \param index, index of the keyframe to remove.  Range of (1, getKeyframeCount()-1).
          
              
      Specified by:
      removeKeyframe in interface Environment
      Parameters:
      index - Takes in a parameter of index
    • getEnvironmentOptionsCount

      public int getEnvironmentOptionsCount()
      Information provided by the PKI file:
      
          \Returns how many environment value types there are.  Categories are not included in the count, just the contents of all combined.
          
          \return int, value is the count of all environment values.
          
              
      Specified by:
      getEnvironmentOptionsCount in interface Environment
      Returns:
      int Returns a int
    • getEnvironment

      public EnvironmentOptions getEnvironment(String env)
      Information provided by the PKI file:
      
          \brief Returns the options for a specified environment value type, like "CO" for carbon monoxide.
          
          \param env, name of the environment value to retrive, like "CO".
          
          \return EnvironmentOptions, value is the options for the specificed environment value type.
          
              
      Specified by:
      getEnvironment in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      EnvironmentOptions Returns a EnvironmentOptions
    • getEnvironmentKeys

      public List<String> getEnvironmentKeys()
      Information provided by the PKI file:
      
          \brief Returns a list of all the environment value types.
          
          \return vector<QString>, value is a list of all the environment value types.
          
              
      Specified by:
      getEnvironmentKeys in interface Environment
      Returns:
      List<String> Returns a List<String>
    • getEnvironmentValue

      public float getEnvironmentValue(String env)
      Information provided by the PKI file:
      
          \brief Returns the value for the specified environment property.
          
          \param env, name of the environment value to retrive, like "CO".
          
          \return float, value is the value of the environment value.  If not found it will return -1, but that can also be a valued value.
          
              
      Specified by:
      getEnvironmentValue in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      float Returns a float
    • getUnit

      public String getUnit(String env)
      Information provided by the PKI file:
      
          \brief Returns the unit used for the specified environment property.
          
          \param env, name of the environment value to retrive, like "CO".
          
          \return QString, value is the unit displayed for the environment value type, like "%" for gasses.  The return can be an empty string.
          
              
      Specified by:
      getUnit in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      String Returns a String
    • getValueWithUnit

      public String getValueWithUnit(String env)
      Information provided by the PKI file:
      
          \brief Returns a string combining the specified environment property and the display unit is uses.
          
          \param env, name of the environment value to retrive, like "CO".
          
          \return QString, value is a string combining the specified environment property and the display unit is uses.
          
              
      Specified by:
      getValueWithUnit in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      String Returns a String
    • getMetricValue

      public float getMetricValue(String env)
      Information provided by the PKI file:
      
          \brief Returns the metric value for the given environment value.
          
          \param env, name of the environment value to retrive, like "CO".
          
          \return float, value is the metric value of the environment value.
          
              
      Specified by:
      getMetricValue in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      float Returns a float
    • setCurrentKeyTime

      public void setCurrentKeyTime(int t)
      Specified by:
      setCurrentKeyTime in interface Environment
      Parameters:
      t - Takes in a parameter of t
    • setNextKeyTime

      public void setNextKeyTime(int t)
      Specified by:
      setNextKeyTime in interface Environment
      Parameters:
      t - Takes in a parameter of t
    • setEditMode

      public void setEditMode(boolean bOn)
      Specified by:
      setEditMode in interface Environment
      Parameters:
      bOn - Takes in a parameter of bOn
    • isEditMode

      public boolean isEditMode()
      Information provided by the PKI file:
      
          \brief Returns true if the environment editor window is in Edit mode.
          
          \return bool, value is true if the enviroment window is in Edit mode, false if it is in View mode.
          
              
      Specified by:
      isEditMode in interface Environment
      Returns:
      boolean Returns a boolean
    • exportToFile

      public void exportToFile()
      Information provided by the PKI file:
      
          \brief Starts the process for saving the environment window values to an xml file.
          
              
      Specified by:
      exportToFile in interface Environment
    • importFromFile

      public void importFromFile()
      Information provided by the PKI file:
      
          \brief Starts the save process for importing the environment window values from an xml file.
          
              
      Specified by:
      importFromFile in interface Environment
    • setAllActive

      public void setAllActive(String envId, boolean bOn)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets them active/inactive.
          
          \param envId, name of the environment to check keyframes for.
          \param bOn, true if keyframes containing the value should be activated, false if deactivated.
          
              
      Specified by:
      setAllActive in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      bOn - Takes in a parameter of bOn
    • setKeyframeActive

      public void setKeyframeActive(int currentKeyframeIndex, String envId, boolean bOn)
      Information provided by the PKI file:
      
          \brief Sets the specified keyframe to active and the environment value in it to be active.
          
          \param currentKeyframeIndex, index of the keyframe to set.
          \param envId, name of the environment to set for in the keyframe.
          \param bOn, true if keyframes containing the value should be activated, false if deactivated.
          
              
      Specified by:
      setKeyframeActive in interface Environment
      Parameters:
      currentKeyframeIndex - Takes in a parameter of currentKeyframeIndex
      envId - Takes in a parameter of envId
      bOn - Takes in a parameter of bOn
    • setAllShow

      public void setAllShow(String envId, boolean bOn)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for show.
          
          \param envId, name of the environment to check keyframes for.
          \param bOn, true if keyframes containing the value and the value should be shown, false if not shown.
          
              
      Specified by:
      setAllShow in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      bOn - Takes in a parameter of bOn
    • setAllTransference

      public void setAllTransference(String envId, float value)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for transference.
          
          \param envId, name of the environment to check keyframes for.
          \param value, transference to use.
          
              
      Specified by:
      setAllTransference in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      value - Takes in a parameter of value
    • setAllInterpolate

      public void setAllInterpolate(String envId, boolean bOn)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for interpolate.
          
          \param envId, name of the environment to check keyframes for.
          \param bOn, true to use interpolation, false to not.
          
              
      Specified by:
      setAllInterpolate in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      bOn - Takes in a parameter of bOn
    • setAllMin

      public void setAllMin(String envId, float value)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for min value allowed.
          
          \param envId, name of the environment to check keyframes for.
          \param value, min value allowed by the environment value.
          
              
      Specified by:
      setAllMin in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      value - Takes in a parameter of value
    • setAllMax

      public void setAllMax(String envId, float value)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for max value allowed.
          
          \param envId, name of the environment to check keyframes for.
          \param value, max value allowed by the environment value.
          
              
      Specified by:
      setAllMax in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      value - Takes in a parameter of value
    • setAllMinRate

      public void setAllMinRate(String envId, float value)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for min rate allowed.
          
          \param envId, name of the environment to check keyframes for.
          \param value, min rate value used by the environment value.
          
              
      Specified by:
      setAllMinRate in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      value - Takes in a parameter of value
    • setAllMaxRate

      public void setAllMaxRate(String envId, float value)
      Information provided by the PKI file:
      
          \brief Goes through all keyframes and staging keyframes and looks for keyframes with the given environment value type and sets the stored value for max rate allowed.
          
          \param envId, name of the environment to check keyframes for.
          \param value, max rate value used by the environment value.
          
              
      Specified by:
      setAllMaxRate in interface Environment
      Parameters:
      envId - Takes in a parameter of envId
      value - Takes in a parameter of value
    • setManualAdjustment

      public void setManualAdjustment(String env, float value)
      Information provided by the PKI file:
      
          \brief Sets the manual adjustment property of the given environment value type.
          
          \param env, the name of the environment value type to set the property for.  Like "CO2".
          
          \param value, value to set the env property value with.
          
              
      Specified by:
      setManualAdjustment in interface Environment
      Parameters:
      env - Takes in a parameter of env
      value - Takes in a parameter of value
    • getCumulativeContribution

      public float getCumulativeContribution(String env, String devName)
      Information provided by the PKI file:
      
          \brief Retrives the cumulative contribution for a device and environment value type.
          
          \param env, name of the environment to read the value for.
          \param devName, device to find the environment value for.
          
          \return float, value is the cumulative contribution based on the params.
          
              
      Specified by:
      getCumulativeContribution in interface Environment
      Parameters:
      env - Takes in a parameter of env
      devName - Takes in a parameter of devName
      Returns:
      float Returns a float
    • setContribution

      public void setContribution(String env, String devName, double rate, double limit, boolean bCumulative)
      Information provided by the PKI file:
      
          \brief Sets the rate, limit and if it is cumulative properties for the environment value for the specified device.
          
          \param env, name of the environment value to set the values for.
          \param devName, device to set for.
          \param rate, rate to use.  If 0 it wipes out all the values and doesn't set any of the values passed.
          \param limit, limit to use.
          \param bCumulative, true if it should be set to cumulative, false if not.
          
              
      Specified by:
      setContribution in interface Environment
      Parameters:
      env - Takes in a parameter of env
      devName - Takes in a parameter of devName
      rate - Takes in a parameter of rate
      limit - Takes in a parameter of limit
      bCumulative - Takes in a parameter of bCumulative
    • removeCumulativeContribution

      public void removeCumulativeContribution(String env, String devName)
      Information provided by the PKI file:
      
          \brief Removes the cumulative contribution for the environment value and device pair.
          
          \param env, name of the environment value to remove for.
          \param devName, device to remove for.
          
              
      Specified by:
      removeCumulativeContribution in interface Environment
      Parameters:
      env - Takes in a parameter of env
      devName - Takes in a parameter of devName
    • setThingTransferenceMultiplier

      public void setThingTransferenceMultiplier(String env, String devName, float multiplier)
      Information provided by the PKI file:
      
          \brief Sets the thing transference multipler the environment value and device pair.
          
          \param env, name of the environment value to remove for.
          \param devName, device to remove for.
          \param multiplier, multiplier to store.
          
              
      Specified by:
      setThingTransferenceMultiplier in interface Environment
      Parameters:
      env - Takes in a parameter of env
      devName - Takes in a parameter of devName
      multiplier - Takes in a parameter of multiplier
    • getTotalContributions

      public float getTotalContributions(String env)
      Information provided by the PKI file:
      
          \brief Retrives the total contribution for all environment entries of the given environment value type.
          
          \param env, name of the environment to read the value for.
          
          \return float, value is the total contribution based of the given environment value type.
          
              
      Specified by:
      getTotalContributions in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      float Returns a float
    • getSimTimeSetting

      public int getSimTimeSetting()
      Information provided by the PKI file:
      
          \brief Retrives second value of the "Simulation Time Scale:".
          
          \return int, retun is the value of the second property of "Simulation Time Scale:".
          
              
      Specified by:
      getSimTimeSetting in interface Environment
      Returns:
      int Returns a int
    • getRealTimeSetting

      public int getRealTimeSetting()
      Information provided by the PKI file:
      
          \brief Retrives first value of the "Simulation Time Scale:".
          
          \return int, retun is the value of the first property of "Simulation Time Scale:".
          
              
      Specified by:
      getRealTimeSetting in interface Environment
      Returns:
      int Returns a int
    • getSimTimeCombo

      public int getSimTimeCombo()
      Specified by:
      getSimTimeCombo in interface Environment
      Returns:
      int Returns a int
    • getRealTimeCombo

      public int getRealTimeCombo()
      Specified by:
      getRealTimeCombo in interface Environment
      Returns:
      int Returns a int
    • setSimTimeSetting

      public void setSimTimeSetting(int s)
      Specified by:
      setSimTimeSetting in interface Environment
      Parameters:
      s - Takes in a parameter of s
    • setRealTimeSetting

      public void setRealTimeSetting(int s)
      Specified by:
      setRealTimeSetting in interface Environment
      Parameters:
      s - Takes in a parameter of s
    • setSimTimeCombo

      public void setSimTimeCombo(int s)
      Specified by:
      setSimTimeCombo in interface Environment
      Parameters:
      s - Takes in a parameter of s
    • setRealTimeCombo

      public void setRealTimeCombo(int s)
      Specified by:
      setRealTimeCombo in interface Environment
      Parameters:
      s - Takes in a parameter of s
    • isUsingMetric

      public boolean isUsingMetric()
      Information provided by the PKI file:
      
          \brief Returns if the environment is using the metric system or imperial.
          
          \return bool, retun is true if the environment it set to use the metric system, false for imperial.
          
              
      Specified by:
      isUsingMetric in interface Environment
      Returns:
      boolean Returns a boolean
    • getNotes

      public String getNotes()
      Specified by:
      getNotes in interface Environment
      Returns:
      String Returns a String
    • setNotes

      public void setNotes(String s)
      Specified by:
      setNotes in interface Environment
      Parameters:
      s - Takes in a parameter of s
    • isShowNotes

      public boolean isShowNotes()
      Information provided by the PKI file:
      
          \brief Returns if notes are set to show in the environment advanced options window.
          
          \return bool, retun is true if notes are set to show, false if set to hidden.
          
              
      Specified by:
      isShowNotes in interface Environment
      Returns:
      boolean Returns a boolean
    • setShowNotes

      public void setShowNotes(boolean b)
      Information provided by the PKI file:
      
          \brief Sets the environment window property for whether notes should be shown in the advanced window.
          
          \param b, true to set notes to show when advanced options are viewied, false if they should be hidden.
          
              
      Specified by:
      setShowNotes in interface Environment
      Parameters:
      b - Takes in a parameter of b
    • isEditingLocked

      public boolean isEditingLocked()
      Information provided by the PKI file:
      
          \brief Returns if the environment editing window has been locked by interace locking option.
          
          \return bool, retun is true if the environment window is locked, false if not.
          
              
      Specified by:
      isEditingLocked in interface Environment
      Returns:
      boolean Returns a boolean
    • addCustomEnvironment

      public void addCustomEnvironment(String categoryId, String category, String id, String name, String metricUnit, String imperialUnit, String imperialFormula, String metricFormula)
      Information provided by the PKI file:
      
          \brief Adds a custom environment value type to the environment.
          
          \param categoryId, category to add the value to, like "Radiation" or "Other".
          \param category, category to add, make it the same as categoryId.
          \param id, name of the environment value.  Like "Sweetness"
          \param name, name to display in the editor window for the environment value.
          \param metricUnit, metric unit to display when display the value is in metric units.
          \param imperialUnit, imperial unit to display when value is in imperial units.
          \param imperialFormula, conversion formula to convert from
          
              
      Specified by:
      addCustomEnvironment in interface Environment
      Parameters:
      categoryId - Takes in a parameter of categoryId
      category - Takes in a parameter of category
      id - Takes in a parameter of id
      name - Takes in a parameter of name
      metricUnit - Takes in a parameter of metricUnit
      imperialUnit - Takes in a parameter of imperialUnit
      imperialFormula - Takes in a parameter of imperialFormula
      metricFormula - Takes in a parameter of metricFormula
    • removeCustomEnvironment

      public void removeCustomEnvironment(String env)
      Information provided by the PKI file:
      
          \brief Removes a custom environment value type from the environment.  This is only for custom properties, not for included properties like "CO2".
          
          \param env, name of the environment value.  Like "Sweetness"
          
              
      Specified by:
      removeCustomEnvironment in interface Environment
      Parameters:
      env - Takes in a parameter of env
    • isCustomEnvironment

      public boolean isCustomEnvironment(String env)
      Information provided by the PKI file:
      
          \brief Returns true if the environment value is a custom environment value.
          
          \return bool, return is true if the environment exists and is a custom property or doesn't exist, false if it is not custom.
          
              
      Specified by:
      isCustomEnvironment in interface Environment
      Parameters:
      env - Takes in a parameter of env
      Returns:
      boolean Returns a boolean
    • getNextKeyTime

      public int getNextKeyTime()
      Information provided by the PKI file:
      
          \brief Debugging tool for getting the next keyframe time.
          
          \return int, return is the next keyframe time.
          
              
      Specified by:
      getNextKeyTime in interface Environment
      Returns:
      int Returns a int
    • getCurrentKeyTime

      public int getCurrentKeyTime()
      Information provided by the PKI file:
      
          \brief Debugging tool for getting the current keyframe time.
          
          \return int, return is the current keyframe time.
          
              
      Specified by:
      getCurrentKeyTime in interface Environment
      Returns:
      int Returns a int
    • getElapsedTime

      public int getElapsedTime(int lastTime)
      Information provided by the PKI file:
      
          \brief Returns the time difference between the given time and the current environment time, in seconds.
          
          \param lastTime, time to subtract from the current time to find the difference.
          
          \return int, return is the time difference between the current time and the given time.
          
              
      Specified by:
      getElapsedTime in interface Environment
      Parameters:
      lastTime - Takes in a parameter of lastTime
      Returns:
      int Returns a int
    • getKeyframeTemplateCount

      public int getKeyframeTemplateCount()
      Information provided by the PKI file:
      
          \brief Returns how many default keyframe categores there are in the "Defaults:" section of the environment window when setting up advanced keyframes.
          
          \return int, return is how many default keyframe categores there are in the "Defaults:" section of the environment window when setting up advanced keyframes.
          
              
      Specified by:
      getKeyframeTemplateCount in interface Environment
      Returns:
      int Returns a int
    • getKeyframeTemplateAt

      public String getKeyframeTemplateAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the default keyframe template name at the given index.
          
          \param index, index of the template to retrive.  Range (0, getKeyFrameTemplateCount())
          
          \return QString, return is the default keyframe template name at the given index if it exists, crash if it doesn't.
          
              
      Specified by:
      getKeyframeTemplateAt in interface Environment
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • importKeyframeTemplate

      public void importKeyframeTemplate(String file)
      Information provided by the PKI file:
      
          \brief Starts importing a default keyframe template.
          
          \param file, the name of the template to import.  Like "Blank.xml".
          
          \return QString, return is the default keyframe template name at the given index if it exists, crash if it doesn't.
          
              
      Specified by:
      importKeyframeTemplate in interface Environment
      Parameters:
      file - Takes in a parameter of file
    • parentEnvironment

      public Environment parentEnvironment()
      Information provided by the PKI file:
      
          \brief Returns the parent environment.
          
          \return Environment, return is the parent environment if it exists, null if not.
          
              
      Specified by:
      parentEnvironment in interface Environment
      Returns:
      Environment Returns a Environment
    • setGraphEnvironment

      public void setGraphEnvironment(String env)
      Specified by:
      setGraphEnvironment in interface Environment
      Parameters:
      env - Takes in a parameter of env
    • getGraphEnvironment

      public String getGraphEnvironment()
      Specified by:
      getGraphEnvironment in interface Environment
      Returns:
      String Returns a String
    • getVolume

      public float getVolume()
      Information provided by the PKI file:
      
          \brief Returns the total volume of the object that contains the environment.
          
          \return float, return is the total volume of the object that contains the environment.
          
              
      Specified by:
      getVolume in interface Environment
      Returns:
      float Returns a float
    • getChangesAsJSON

      public String getChangesAsJSON()
      Information provided by the PKI file:
      
          \brief Returns change information as JSON data.
          
          \return QString, return is the change information as JSON data.
          
              
      Specified by:
      getChangesAsJSON in interface Environment
      Returns:
      String Returns a String
    • getKeyframeDataAsJSON

      public String getKeyframeDataAsJSON(String envID)
      Information provided by the PKI file:
      
          \brief Returns keyframes with the given environment value as JSON data.
          
          \param envID, the environment variable type to get the information for.
          
          \return QString, return is the keyframes' information for the given environment value as JSON data.
          
              
      Specified by:
      getKeyframeDataAsJSON in interface Environment
      Parameters:
      envID - Takes in a parameter of envID
      Returns:
      String Returns a String
    • removeEnvironmentKeyframe

      public boolean removeEnvironmentKeyframe(String envID, int time)
      Information provided by the PKI file:
      
          \brief Removes the environment keyframe at the given time if it has the given environment variable type and it isn't the start or end keyframe.
          
          \param envID,  the environment variable type that must be in the specified keyframe time for it to be removed.
          \param time, the environment time of the keyframe to remove.
          
          \return bool, return is true a keyframe was removed, false if not.
          
              
      Specified by:
      removeEnvironmentKeyframe in interface Environment
      Parameters:
      envID - Takes in a parameter of envID
      time - Takes in a parameter of time
      Returns:
      boolean Returns a boolean